home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tm / tmsgipanel.z / tmsgipanel
Encoding:
Text File  |  1998-10-30  |  9.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))                                                TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll - the SGI IconPanel widget class
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ssssggggiiiiPPPPaaaannnneeeellll  pathName [options]
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      This is the _t_c_l binding to the SGI ViewKit IconPanel widget.
  17.  
  18.  
  19. CCCCLLLLAAAASSSSSSSSEEEESSSS
  20.      The class name for resource files is IIIIccccoooonnnnPPPPaaaannnneeeellll.... Resources are inherited
  21.      from TTTTmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee,,,, TTTTmmmmCCCCoooorrrreeee.... Methods are inherited from TTTTmmmmCCCCoooorrrreeee....
  22.  
  23.  
  24. MMMMEEEETTTTHHHHOOOODDDDSSSS
  25.      New methods for this class are:
  26.  
  27.           activateCallback
  28.           deselect
  29.           getRenameText
  30.           icon
  31.           iconState
  32.           list
  33.           postCallback
  34.           remove
  35.           render
  36.           rename
  37.           renameable
  38.           scale
  39.           selection
  40.           select
  41.           view
  42.  
  43.  
  44.      aaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk action block
  45.           The activate callback is called before an icon action has taken
  46.           place.  The actions are: DDDDrrrroooopppp,,,, DDDDrrrrooooppppCCCCrrrreeeeaaaatttteeee,,,, OOOOppppeeeennnn,,,, """"TTTTrrrreeeeeeee OOOOppppeeeennnn"""",,,, """"AAAAlllltttt
  47.           OOOOppppeeeennnn"""",,,, PPPPrrrriiiinnnntttt,,,, RRRReeeennnnaaaammmmeeee,,,, MMMMoooottttiiiioooonnnn,,,, CCCCoooonnnnffffiiiigggguuuurrrreeee,,,, EEEExxxxppppoooosssseeee,,,, SSSSeeeelllleeeecccctttt,,,, BBBBooooxxxx,,,,
  48.           AAAAddddjjjjuuuusssstttt,,,, DDDDrrrraaaagggg,,,, KKKKeeeeyyyybbbbooooaaaarrrrdddd,,,, EEEEnnnntttteeeerrrr,,,, LLLLeeeeaaaavvvveeee,,,, DDDDrrrraaaaggggEEEEnnnntttteeeerrrr,,,, DDDDrrrraaaaggggMMMMoooottttiiiioooonnnn,,,, aaaannnndddd
  49.           DDDDrrrraaaaggggLLLLeeeeaaaavvvveeee....  Block is a Tcl code segment.  The block must return
  50.           non-zero for the standard actions to be called.
  51.  
  52.  
  53.      ddddeeeesssseeeelllleeeecccctttt iconName
  54.           The deselect method will remove an icon from the panel selection
  55.           list and change the iconState to unselected.
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))                                                TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))
  71.  
  72.  
  73.  
  74.      ggggeeeettttRRRReeeennnnaaaammmmeeeeTTTTeeeexxxxtttt
  75.           The getRenameText method returns the global renameText string for
  76.           the panel.  It is usually called as a postCallback for the rename
  77.           event.
  78.  
  79.  
  80.      iiiiccccoooonnnn createString
  81.           The icon function will add a new icon to a panel.  The createString
  82.           is a keyword:data list where the keywords are: NNNNaaaammmmeeee,,,, DDDDiiiissssppppllllaaaayyyyNNNNaaaammmmeeee,,,,
  83.           UUUUnnnniiiiqqqquuuueeeeNNNNaaaammmmeeee,,,, CCCCaaaatttteeeeggggoooorrrryyyy,,,, and TTTTyyyyppppeeee....  The known categories are: HHHHoooosssstttt,,,,
  84.           FFFFiiiilllleeee,,,, IIIIccccoooonnnnTTTTyyyyppppeeee,,,, and PPPPrrrriiiinnnntttteeeerrrr....  If the category is IconType then the
  85.           name field becomes the type of the icon, and the uniqueName field
  86.           becomes the name as well.
  87.  
  88.  
  89.      iiiiccccoooonnnnSSSSttttaaaatttteeee iconName [!]state
  90.           The iconState function changes the icon visual display state for a
  91.           given icon.  The state can be one of: ooooppppeeeennnneeeedddd,,,, ddddiiiissssaaaabbbblllleeeedddd,,,, llllooooccccaaaatttteeeedddd,,,,
  92.           sssseeeelllleeeecccctttteeeedddd,,,, ccccuuuurrrrrrrreeeennnntttt,,,, ddddrrrraaaaggggSSSSeeeelllleeeecccctttteeeedddd,,,, and ddddiiiissssaaaabbbblllleeeeddddSSSSeeeelllleeeecccctttteeeedddd....  If the state
  93.           string is prepended by a '!' character then the state is removed
  94.           from the icon.
  95.  
  96.  
  97.      lllliiiisssstttt [displayOption]
  98.           The list method will return all of the icons on a panel.  By default
  99.           the uniqueName element of each icon is returned, but this can be
  100.           changed by the displayOption which can be: ----ddddiiiissssppppllllaaaayyyy to return the
  101.           displayName of each icon, or ----eeeennnnccccooooddddeeee to return the create string for
  102.           each icon.
  103.  
  104.  
  105.      ppppoooossssttttCCCCaaaallllllllbbbbaaaacccckkkk action block
  106.           The postCallback method adds a new callback for the panel for the
  107.           given action.  The actions are the same as for an activateCallback.
  108.           The postCallback is called after the standard callbacks have been
  109.           called and the action has taken place.
  110.  
  111.  
  112.      rrrreeeemmmmoooovvvveeee iconName
  113.           The remove method will remove the named icon from the panel.
  114.  
  115.  
  116.      rrrreeeennnnddddeeeerrrr
  117.           The render method must be called to redisplay the panel after any
  118.           change has been made.
  119.  
  120.  
  121.      rrrreeeennnnaaaammmmeeee iconName displayName
  122.           The rename method will change the displayName of the named icon.
  123.           The uniqueName of the icon is unchanged.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))                                                TTTTmmmmSSSSggggiiiiPPPPaaaannnneeeellll((((3333TTTTmmmm))))
  137.  
  138.  
  139.  
  140.      rrrreeeennnnaaaammmmeeeeaaaabbbblllleeee boolean [iconName]
  141.           The renamable method will toggle the renamability of an icon or an
  142.           entire panel.  If an icon is marked as renamable then selecting the
  143.           icon will bring up a text field through which the panel renameText
  144.           can be changed.  To actually change the icon displayName the rename
  145.           method must be called as a postCallback for the rename event.
  146.  
  147.  
  148.      ssssccccaaaalllleeee value
  149.           The scale method will change the zoom factor of the panel.  It
  150.           should be a floating point number between 0 and 1.  The icon sizes
  151.           will change accordingly.  Only the current view is affected by a
  152.           change in scale.
  153.  
  154.  
  155.      sssseeeelllleeeeccccttttiiiioooonnnn [displayOption]
  156.           The selection method will return all of the icons on a panel that
  157.           have been selected.  By default the uniqueName element of each icon
  158.           is returned, but this can be changed by the displayOption which can
  159.           be: ----ddddiiiissssppppllllaaaayyyy to return the displayName of each icon, or ----eeeennnnccccooooddddeeee to
  160.           return the create string for each icon.
  161.  
  162.  
  163.      sssseeeelllleeeecccctttt iconName
  164.           The select method will add an icon to the panel selection list, and
  165.           will change the state of the icon to selected.
  166.  
  167.  
  168.      vvvviiiieeeewwww viewOption
  169.           The view method changes how icons are displayed.  The currently
  170.           available panel views are: LLLLiiiisssstttt,,,, IIIIccccoooonnnn,,,, CCCCoooolllluuuummmmnnnn,,,, TTTTrrrreeeeeeee,,,, and BBBBBBBBooooaaaarrrrdddd.....
  171.  
  172.  
  173. CCCCAAAALLLLLLLLBBBBAAAACCCCKKKK SSSSUUUUBBBBSSSSTTTTIIIITTTTUUUUTTTTIIIIOOOONNNNSSSS
  174.      No substitutions are supported for this class.
  175.  
  176.  
  177. BBBBUUUUGGGGSSSS
  178.      Display names containing characters that are illegal, or unsavory in
  179.      filenames are not editable.  That is, you cannot put a & or " " in an
  180.      icon displayName if you want it to be user editable.
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.